home *** CD-ROM | disk | FTP | other *** search
/ Super Audio / Super Audio.iso / replay / _armovie / documents / extract < prev    next >
Text File  |  1997-11-10  |  9KB  |  180 lines
  1.  
  2.                               HOW TO RUN EXTRACT
  3.                               ++++++++++++++++++
  4.                               
  5.                            Related Documents: Join (Version 3.06, 1 May,'94)
  6.                            
  7. Author:    CRose
  8. Date:      29 April, 1994.
  9. Version:   2.19
  10. File Name: Extract
  11.  
  12.  
  13. WHAT DOES EXTRACT DO?    Extracts one or more components of an Armovie file.
  14. --------------------     The extracted components can then be used by Join
  15.                          (see Join documentation) to build new Armovie files.
  16.                          You can extract the header, sprite, keys, images,
  17.                          and / or any or all of the sound tracks.  Unlike
  18.                          version 2.00, it is now possible to extract
  19.                          sound and images simultaneously and any other 
  20.                          combination of extracts is now possible.
  21.                          
  22. THE SOURCE DATA:    All extract needs is the Armovie to extract from and a
  23. ---------------     destination directory in which to place the extracts.
  24.  
  25.                            
  26. EXTRACTING SOUND DATA:  If you use the -sound parameter with Extract (see 
  27. ---------------------   examples below) but you do not specify which sound
  28.                         track/s you want, then by default only the first track 
  29.                         will be extracted.  Extract will use the Armovie's
  30.                         header to determine whether the sound is at four,
  31.                         eight, or sixteen bits per sample and will name 
  32.                         extracted sound data accordingly.  (At 4 bits per 
  33.                         sample - "adpcm", at 8 bits per sample - "sound",
  34.                         and at 16 bits per sample - "samples").  If, for 
  35.                         example you want to extract all the sound tracks 
  36.                         from a 5 track Armovie where the number of bits
  37.                         per sample is:
  38.                         
  39.                         Track 1 : 4 bits per sample (adpcm).
  40.                         Track 2 : 16 bits per sample (samples).
  41.                         Track 3 : 8 bits per sample (sound).
  42.                         Track 4 : 8 bits per sample ((sound).
  43.                         Track 5 : 4 bits per sample (adpcm).
  44.                         
  45.                         ... then the resulting extracts will be:
  46.                         
  47.                         Track 1 : "Adpcm"
  48.                         Track 2 : "Samples"
  49.                         Track 3 : "Sound"
  50.                         Track 4 : "Sound2"
  51.                         Track 5 : "Adpcm2"
  52.  
  53.  
  54. PARAMETERS:  The parameters for running Extract are as follows.
  55. ----------  
  56.     
  57.   -source    (necessary) The name of the Armovie from which to extract data.
  58.   -dest      (necessary) The name of an existing destination directory in 
  59.                          which to put the extracted data.
  60.   -header    (optional)  Extract the header.
  61.   -sprite    (optional)  Extract the sprite.
  62.   -keys      (optional)  Extract keys.
  63.   -images    (optional)  Extract images.
  64.   -sound     (optional)  Extract sound. Specific sound track/s can be specified
  65.                          (see examples below).
  66.   -help      (optional)                         
  67.                          
  68.                      
  69.   By default, Extract will pull out all of the above if you only specify a
  70.   source and destination (this includes ALL of the sound tracks).  If particular 
  71.   components of the Armovie do not exist (e.g. if the Armovie has no keys), then 
  72.   Extract will simply generate warning messages and ignore the parameter concerned.
  73.   
  74.   For on-line help just type the name of the program followed by -help.  
  75.   
  76.   
  77. EXAMPLES:
  78. --------
  79.  
  80. Example 1:  extract -help
  81. ---------       
  82.             This will give help information (although obviously it won't 
  83.             be as detailed as this document).
  84.        
  85. Example 2:  extract -source $.my_armovie -dest $.extracts -images
  86. ---------
  87.             This will extract all the image data from $.my_armovie and 
  88.             place it in the extracts directory.  The data is split up
  89.             into separate files within one or more image directories
  90.             ready to be used by Join at some later stage.  If my_armovie
  91.             is a sound only Armovie then Extract will warn you of this
  92.             and ignore the extraction request.
  93.             
  94. Example 3:  extract -source $.my_armovie -dest $.extracts -keys
  95. ---------   
  96.             This will extract all the keys data from $.my_armovie and
  97.             place it in the extracts directory.  The data is split up
  98.             into separate files within one or more keys directories
  99.             ready to be used by Join at some later stage.  If my_armovie
  100.             does not contain any keys information then Extract will 
  101.             notify you of this and nothing will be extracted.
  102.             
  103. Example 4:  extract -source $.my_armovie -dest $.extracts -images -keys
  104. ---------
  105.             This combines examples 2 and 3 above.  Again, if images
  106.             or keys do not exist in the Armovie file, Extract will
  107.             issue appropriate warning message/s and will ignore the
  108.             parameter/s concerned.
  109.             
  110. Example 5:  extract -source $.my_armovie -dest $.extracts -images -sound 3 5
  111. ---------
  112.             This will extract all the images, along with the third and
  113.             fifth sound tracks (if they exist).
  114.             
  115. Example 6:  extract -source $.my_armovie -dest $.extracts
  116. ---------   
  117.             In this case Extract tries to extract all the components of the
  118.             ARMovie, i.e. header, sprite, keys, images, and all the sound
  119.             tracks.  If there are no keys then Extract will generate a warning 
  120.             message and will carry on with the remainder of the extracts. 
  121.             Similarly, if there is no image data or no sound data then
  122.             Extract will tell you this before proceeding with the remainder
  123.             of the extracts.           
  124.             
  125.             
  126.             
  127. OTHER POINTS WORTH MENTIONING:
  128. -----------------------------
  129.  
  130. If you ask Extract to extract data which does not exist in the source Armovie
  131. file, it will notify you of this and will carry on doing any other extracts
  132. that you have asked for (if the data exists).  The only exception to this is
  133. if you ask for a sound track which does not exist.  In this case, Extract will
  134. tell you that the sound track does not exist and will end at that point.           
  135.   
  136. If Extract is terminated prematurely (e.g. user presses escape), an exception
  137. handler will ensure that any open files are closed.  For obvious reasons this
  138. only applies to files opened by Extract.            
  139.  
  140. There are two classes of error message.  Warnings may be ignored depending
  141. upon context and requirements (e.g. extraction of images when there are no
  142. images in the source file).  Fatal errors will actually stop the program at 
  143. that point.  As mentioned above, an exception handler will ensure that any 
  144. files opened by Extract are closed.
  145.  
  146. As well as taking in parameters from the command line, Extract will also look for
  147. parameters held in the environment variable extract$ExtraArgs.  The split can 
  148. occur anywhere.  e.g. extract -source $.MyArmovie -de may be entered on the command
  149. line, while st $.Extracts may be held in extract$ExtraArgs.  Extract will simply 
  150. join the two together to produce extract -source $.MyArmovie -dest $.Extracts .                   
  151.            
  152. When extracting image data you should make a note of the number of frames
  153. per chunk that are in the ARMovie which you're extracting from.  This 
  154. information is on line 14.  This is so that when it comes to using Join
  155. to build another ARMovie you are able to provide the correct number of
  156. frames per chunk in your own header when using these images (the correct
  157. number being exactly what it was in the first place).  A good indication
  158. that you have the wrong number of frames per chunk in your header is that
  159. when you play the ARMovie, the picture will start off o.k. and will then
  160. become fuzzy and will then be o.k. and then become fuzzy, and so on.  
  161.  
  162. If you use Extract followed by Join and come to the conclusion that either
  163. Extract or Join is not working as it should, you should first check that
  164. your header is correct as this is usually the most likely source of error.
  165.  
  166.  
  167.  
  168. DIFFERENCES BETWEEN CURRENT VERSION (2.19) &  PREVIOUS VERSION:
  169. --------------------------------------------------------------------
  170.  
  171. Wasn't checking to see if the last track was stereo or mono in multi-
  172. track ARMovies.
  173.  
  174.  
  175. OUTSTANDING:
  176. -----------
  177.  
  178. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~      
  179.   
  180.